<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta name="Content-Type" content="text/html; charset=UTF-8" />
<title>Module: Sass::Plugin::Configuration</title>
<link rel="stylesheet" href="style.css" tppabs="http://sass-lang.com/docs/yardoc/css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="common.css" tppabs="http://sass-lang.com/docs/yardoc/css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  relpath = '../..';
  if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="jquery.js" tppabs="http://sass-lang.com/docs/yardoc/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="app.js" tppabs="http://sass-lang.com/docs/yardoc/js/app.js"></script>

  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <div id="menu">
  
    <a href="_index.html" tppabs="http://sass-lang.com/docs/yardoc/_index.html">Index (C)</a> &raquo; 
    <span class='title'><a href="Sass-1.html" tppabs="http://sass-lang.com/docs/yardoc/Sass.html" title="Sass (module)">Sass</a></span> &raquo; <span class='title'><a href="Plugin.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Plugin.html" title="Sass::Plugin (module)">Plugin</a></span>
     &raquo; 
    <span class="title">Configuration</span>
  
  
  <div class="noframes"><span class="title">(</span><a href="javascript:if(confirm(%27http://sass-lang.com/docs/yardoc/Sass/Plugin/.  \n\nThis file was not retrieved by Teleport Pro, because the server reports that this file cannot be found.  \n\nDo you want to open it from the server?%27))window.location=%27http://sass-lang.com/docs/yardoc/Sass/Plugin/.%27" tppabs="http://sass-lang.com/docs/yardoc/Sass/Plugin/." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  <a id="class_list_link" href="#">Class List</a>
  <a id="method_list_link" href="#">Method List</a>
  <a id ="file_list_link" href="#">File List</a>
</div>

      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><h1>Module: Sass::Plugin::Configuration 
  
  
</h1>

<dl class="box">
  
  
    
  
    
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb</dd>
  
</dl>
<div class="clear"></div>




  <h2>Instance Method Summary</h2>

  <ul class="summary">
    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#add_template_location-instance_method" title="#add_template_location (instance method)">- <strong>add_template_location</strong>(template_location, css_location = options[:css_location]) </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Adds a new template-location/css-location mapping.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#default_options-instance_method" title="#default_options (instance method)">- ({Symbol =&gt; Object}) <strong>default_options</strong> </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Returns the default options for a <tt><a href="Compiler.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Plugin/Compiler.html" title="Sass::Plugin::Compiler (class)">Sass::Plugin::Compiler</a></tt>.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#options-instance_method" title="#options (instance method)">- ({Symbol =&gt; Object}) <strong>options</strong> </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">An options hash.</span>
  
</li>

    
      <li class="public deprecated">
  <span class="summary_signature">
    
      <a href="#options%3D-instance_method" title="#options= (instance method)">- <strong>options</strong>(value) </a>
    

    
  </span>
  
  
  
  
  <span class="deprecated note title">Deprecated</span>

  
    <span class="summary_desc"><strong>Deprecated.</strong> Instead, modify the options hash in-place.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#remove_template_location-instance_method" title="#remove_template_location (instance method)">- (Boolean) <strong>remove_template_location</strong>(template_location, css_location = options[:css_location]) </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Removes a template-location/css-location mapping.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#reset%21-instance_method" title="#reset! (instance method)">- <strong>reset!</strong> </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Resets the options and <tt><a href="InstanceMethods.html#clear_callbacks%21-instance_method" tppabs="http://sass-lang.com/docs/yardoc/Sass/Callbacks/InstanceMethods.html#clear_callbacks%21-instance_method" title="Sass::Callbacks::InstanceMethods#clear_callbacks! (method)">clears all callbacks</a></tt>.</span>
  
</li>

    
      <li class="public ">
  <span class="summary_signature">
    
      <a href="#template_location_array-instance_method" title="#template_location_array (instance method)">- (Array&lt;(String, String)&gt;) <strong>template_location_array</strong> </a>
    

    
  </span>
  
  
  
  
  

  
    <span class="summary_desc">Returns the template locations configured for Sass as an array of <code>[template_location, css_location]</code> pairs.</span>
  
</li>

    
  </ul>


  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>
    
    
      <div class="method_details first">
  <p class="signature first" id="add_template_location-instance_method">
  
    - <strong>add_template_location</strong>(template_location, css_location = options[:css_location]) 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Adds a new template-location/css-location mapping. This means that Sass/SCSS files in <code>template_location</code> will be compiled to CSS files in <code>css_location</code>.</p>

<p>This is preferred over manually manipulating the <a href="file.SASS_REFERENCE.html#template_location-option" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#template_location-option" title="&lt;code&gt;:template_location&lt;/code&gt; option"><code>:template_location</code> option</a> since the option can be in multiple formats.</p>

<p>Note that this method will change <code>options[:template_location]</code> to be in the Array format. This means that even if <code>options[:template_location]</code> had previously been a Hash or a String, it will now be an Array.</p>

  </div>
</div>
<div class="tags">
  <h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>template_location</span>
      
      
      
        &mdash;
        The location where Sass/SCSS files will be.
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>css_location</span>
      
      
        <em class="default">(defaults to: <tt>options[:css_location]</tt>)</em>
      
      
        &mdash;
        The location where compiled CSS files will go.
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


62
63
64
65</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 62</span>

def add_template_location(template_location, css_location = options[:css_location])
  normalize_template_location!
  template_location_array << [template_location, css_location]
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="default_options-instance_method">
  
    - (<tt>{Symbol =&gt; Object}</tt>) <strong>default_options</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Returns the default options for a <tt><a href="Compiler.html" tppabs="http://sass-lang.com/docs/yardoc/Sass/Plugin/Compiler.html" title="Sass::Plugin::Compiler (class)">Sass::Plugin::Compiler</a></tt>.</p>

  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
      
      
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


12
13
14
15
16
17
18
19
20</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 12</span>

def default_options
  @default_options ||= {
    :css_location       => './public/stylesheets',
    :always_update      => false,
    :always_check       => true,
    :full_exception     => true,
    :cache_location     => ".sass-cache"
  }.freeze
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="options-instance_method">
  
    - (<tt>{Symbol =&gt; Object}</tt>) <strong>options</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>An options hash. See <a href="file.SASS_REFERENCE.html#sass_options" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#sass_options" title="the Sass options documentation">the Sass options documentation</a>.</p>

  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
      
      
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


32
33
34</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 32</span>

def options
  @options ||= default_options.dup
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="options=-instance_method">
  
    - <strong>options=</strong>(value) 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p class="note deprecated"><strong>Deprecated.</strong> Instead, modify the options hash in-place.</p>
<p>Sets the options hash. See <a href="file.SASS_REFERENCE.html#sass_options" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#sass_options" title="the Sass options documentation">the Sass options documentation</a>. See <tt><a href="#reset%21-instance_method" title="Sass::Plugin::Configuration#reset! (method)">Sass::Plugin::Configuration#reset!</a></tt></p>

  </div>
</div>
<div class="tags">
  <h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>{Symbol =&gt; Object}</tt>)</span>
      
      
        <span class='name'>value</span>
      
      
      
        &mdash;
        The options hash
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


41
42
43
44
45</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 41</span>

def options=(value)
  Sass::Util.sass_warn("Setting Sass::Plugin.options is deprecated " +
                       "and will be removed in a future release.")
  options.merge!(value)
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="remove_template_location-instance_method">
  
    - (<tt>Boolean</tt>) <strong>remove_template_location</strong>(template_location, css_location = options[:css_location]) 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Removes a template-location/css-location mapping. This means that Sass/SCSS files in <code>template_location</code> will no longer be compiled to CSS files in <code>css_location</code>.</p>

<p>This is preferred over manually manipulating the <a href="file.SASS_REFERENCE.html#template_location-option" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#template_location-option" title="&lt;code&gt;:template_location&lt;/code&gt; option"><code>:template_location</code> option</a> since the option can be in multiple formats.</p>

<p>Note that this method will change <code>options[:template_location]</code> to be in the Array format. This means that even if <code>options[:template_location]</code> had previously been a Hash or a String, it will now be an Array.</p>

  </div>
</div>
<div class="tags">
  <h3>Parameters:</h3>
<ul class="param">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>template_location</span>
      
      
      
        &mdash;
        The location where Sass/SCSS files were, which is now going to be ignored.
      
    </li>
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <span class='name'>css_location</span>
      
      
        <em class="default">(defaults to: <tt>options[:css_location]</tt>)</em>
      
      
        &mdash;
        The location where compiled CSS files went, but will no longer go.
      
    </li>
  
</ul>
<h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
      
      
        &mdash;
        Non-<code>nil</code> if the given mapping already existed and was removed, or <code>nil</code> if nothing was changed.
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


88
89
90
91</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 88</span>

def remove_template_location(template_location, css_location = options[:css_location])
  normalize_template_location!
  template_location_array.delete([template_location, css_location])
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="reset!-instance_method">
  
    - <strong>reset!</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Resets the options and <tt><a href="InstanceMethods.html#clear_callbacks%21-instance_method" tppabs="http://sass-lang.com/docs/yardoc/Sass/Callbacks/InstanceMethods.html#clear_callbacks%21-instance_method" title="Sass::Callbacks::InstanceMethods#clear_callbacks! (method)">clears all callbacks</a></tt>.</p>

  </div>
</div>
<div class="tags">
  
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


23
24
25
26</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 23</span>

def reset!
  @options = nil
  clear_callbacks!
end</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <p class="signature " id="template_location_array-instance_method">
  
    - (<tt>Array&lt;(String, String)&gt;</tt>) <strong>template_location_array</strong> 
  

  
</p><div class="docstring">
  <div class="discussion">
    <p>Returns the template locations configured for Sass as an array of <code>[template_location, css_location]</code> pairs. See the <a href="file.SASS_REFERENCE.html#template_location-option" tppabs="http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#template_location-option" title="&lt;code&gt;:template_location&lt;/code&gt; option"><code>:template_location</code> option</a> for details.</p>

  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>Array&lt;(String, String)&gt;</tt>)</span>
      
      
      
      
        &mdash;
        An array of <code>[template_location, css_location]</code> pairs.
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


100
101
102
103
104
105
106</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File '/var/www/sass-pages/.sass/lib/sass/plugin/configuration.rb', line 100</span>

def template_location_array
  old_template_location = options[:template_location]
  normalize_template_location!
  options[:template_location]
ensure
  options[:template_location] = old_template_location
end</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>
    
    <div id="footer">
  Generated on Fri Mar  8 20:33:46 2013 by 
  <a href="javascript:if(confirm(%27http://yardoc.org/  \n\nThis file was not retrieved by Teleport Pro, because it is addressed on a domain or path outside the boundaries set for its Starting Address.  \n\nDo you want to open it from the server?%27))window.location=%27http://yardoc.org/%27" tppabs="http://yardoc.org/" title="Yay! A Ruby Documentation Tool">yard</a>
  0.5.3 (ruby-1.8.7).
</div>


  <script type="text/javascript">
  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
  </script>
  <script type="text/javascript">
  try {
  var pageTracker = _gat._getTracker("UA-535380-8");
  pageTracker._trackPageview();
  } catch(err) {}</script>


  </body>
</html>